 |
API Documentation
|
|
|
Function * getFunc(const nkMemory::StringView &name)
Defines an environment in which scripts can execute.
Definition: Environment.h:14
void setVar(const nkMemory::StringView &name, bool value)
Encompasses all API of component NilkinsScripts.
Definition: Environment.h:7
void setVar(const nkMemory::StringView &name, const ScriptObjectReference &value)
Holds information and allow control over a namespace in a scripting environment.
Definition: Namespace.h:12
Holds all information for a script.
Definition: Script.h:14
A view over data.
Definition: BufferView.h:18
void setEnvironmentFor(INTERPRETER interpretType)
ScriptObjectReference deserializeScriptObject(const nkMemory::BufferView< unsigned char > &object)
Function * setFunc(const nkMemory::StringView &name)
ScriptObjectReference getScriptFunction(const nkMemory::StringView &name)
int getVar(const nkMemory::StringView &name, int defaultValue)
double getVar(const nkMemory::StringView &name, double defaultValue)
void setVar(const nkMemory::StringView &name, int value)
void * getObject(const nkMemory::StringView &name, const nkMemory::StringView &userTypeName=nullptr)
bool isFuncSet(const nkMemory::StringView &name)
void setVar(const nkMemory::StringView &name, const char *value)
Namespace * getNamespace(const nkMemory::StringView &name)
Namespace * setNamespace(const nkMemory::StringView &name)
bool isNamespaceSet(const nkMemory::StringView &name)
void setVar(const nkMemory::StringView &name, float value)
Represents a user type and all the information and control related.
Definition: UserType.h:27
std::vector< FunctionParameter > DataStack
A data stack, mainly used for parameters.
Definition: FunctionDefines.h:8
float getVar(const nkMemory::StringView &name, float defaultValue)
A buffer holding binary data.
Definition: Buffer.h:32
const nkMemory::StringView & getVar(const nkMemory::StringView &name, const nkMemory::StringView &defaultValue)
A reference over an object in the scripting environment.
Definition: ScriptObjectReference.h:30
void setVar(const nkMemory::StringView &name, double value)
bool callScriptFunction(const ScriptObjectReference &reference, const DataStack &args, DataStack &expectedOutput)
bool isVarSet(const nkMemory::StringView &name)
void setVar(const nkMemory::StringView &name, const nkMemory::StringView &value)
UserType * setUserType(const nkMemory::StringView &name)
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
bool getVar(const nkMemory::StringView &name, bool defaultValue)
UserType * getUserType(const nkMemory::StringView &name)
Holds information about the execution result of a script in an environment.
Definition: ExecutionResult.h:26
INTERPRETER
Supported scripting environments.
Definition: Interpreter.h:12
void setName(const nkMemory::StringView &name)
void requestGarbageCollection()
ScriptObjectReference getVar(const nkMemory::StringView &name)
bool isUserTypeSet(const nkMemory::StringView &name)
nkMemory::StringView getName() const
bool execute(const Script &script)
Holds information, and controls, over a function in a scripting environment.
Definition: Function.h:50
void setObject(const nkMemory::StringView &name, const nkMemory::StringView &userTypeName, void *value)
nkMemory::Buffer serializeScriptObject(const ScriptObjectReference &reference, bool forwardUserDataOwnership=false)
const ExecutionResult & getLastExecutionResult() const